GET api/account/cancel-contract-tasks?clientIDs[0]={clientIDs[0]}&clientIDs[1]={clientIDs[1]}&taskStatuses[0]={taskStatuses[0]}&taskStatuses[1]={taskStatuses[1]}
Get cancel contract tasks. Results are sorted by the created date and status.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientIDs |
Client IDs to filter on |
Collection of integer |
Required |
| taskStatuses |
Task statuses to filter on |
Collection of enTaskStatus |
Required |
Body Parameters
None.
Response Information
Resource Description
List of cancel contract tasks
Collection of CancelContractTask| Name | Description | Type | Additional information |
|---|---|---|---|
| ContractNoteID |
ID of the contract to cancel |
integer |
None. |
| ID |
Task ID |
integer |
None. |
| Type |
Task Type |
enTaskType |
None. |
| Description |
Task description |
string |
None. |
| DateTimeCreated |
Created date time |
date |
None. |
| DateTimeUpdated |
Updated date time |
date |
None. |
| Status |
Task status |
enTaskStatus |
None. |
| RejectionReason |
Rejection reason |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ContractNoteID": 1,
"ID": 2,
"Type": 0,
"Description": "sample string 3",
"DateTimeCreated": "2025-11-08T20:52:53.2995777+11:00",
"DateTimeUpdated": "2025-11-08T20:52:53.2995777+11:00",
"Status": 0,
"RejectionReason": "sample string 5"
},
{
"ContractNoteID": 1,
"ID": 2,
"Type": 0,
"Description": "sample string 3",
"DateTimeCreated": "2025-11-08T20:52:53.2995777+11:00",
"DateTimeUpdated": "2025-11-08T20:52:53.2995777+11:00",
"Status": 0,
"RejectionReason": "sample string 5"
}
]
application/xml, text/xml
Sample:
<ArrayOfCancelContractTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Tasks">
<CancelContractTask>
<DateTimeCreated>2025-11-08T20:52:53.2995777+11:00</DateTimeCreated>
<DateTimeUpdated>2025-11-08T20:52:53.2995777+11:00</DateTimeUpdated>
<Description>sample string 3</Description>
<ID>2</ID>
<RejectionReason>sample string 5</RejectionReason>
<Status>New</Status>
<Type>GenericTask</Type>
<ContractNoteID>1</ContractNoteID>
</CancelContractTask>
<CancelContractTask>
<DateTimeCreated>2025-11-08T20:52:53.2995777+11:00</DateTimeCreated>
<DateTimeUpdated>2025-11-08T20:52:53.2995777+11:00</DateTimeUpdated>
<Description>sample string 3</Description>
<ID>2</ID>
<RejectionReason>sample string 5</RejectionReason>
<Status>New</Status>
<Type>GenericTask</Type>
<ContractNoteID>1</ContractNoteID>
</CancelContractTask>
</ArrayOfCancelContractTask>